/*
 * ============================================================================
 *                   GNU Lesser General Public License
 * ============================================================================
 *
 *
 *
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
 * 
 *
 *
 */
package rad.framework.validator;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import org.hibernate.validator.ValidatorClass;

/**
 * This can be used in combination with the unique attribute on the Column
 * annotation. It allows these validation errors to be catch proactively during
 * the JSF validation phase.
 * 
 * If property is not set then it is assumed that Hibernate's @NaturalId is being used.
 * 
 * @author boudyacho
 * 
 */
@Documented
@ValidatorClass(UniqueValidator.class)
@Target( { ElementType.TYPE })
@Retention(RUNTIME)
public @interface Unique {
	/**
	 * The name of the property that must be unique.
	 * 
	 * @return
	 */
	String property() default "";

	String message() default "Must be unique.";

	/** @deprecated */
	String entityManager() default "entityManager";
}
